AcceptReturn

This operation transfers the council's decision whether to accept or return the DA case from the council's IT system to the Online DA Service. This operation includes 'Completeness check' and 'Fee paid and lodged' stages in UI. If Completeness check is performed in UI then the subsequent action Fee Paid and lodged could be performed only in UI and not via API.

Authorizations:
apiKeyHeaderapiKeyQuery
path Parameters
CaseID
required
string

A fully qualified application number.

header Parameters
OrganisationID
required
string

Used by the API gateway to identify the council LGA name from which the request was initiated.

IdempotencyID
required
string

Unique Id for this request. Allows the API to respond in an idempotent way if it has already been called with these parameters and prevents duplicate processing. Typically a UUID such as "63a9ba30-7a4b-4fac-b343-d1f05cf089f1"

Request Body schema: application/json
lodgementOutcome
required
string

This is to track the council's acceptance or rejection of an application. Example values are as below. Please refer to reference data API for the latest values. 1. Application was lodged 2. Application was returned

isFeesPaid
boolean

This is to track if applicant had paid the fee.

isFeePayableunderPart13
boolean

This gives the ability to mark a modification DA as lodged on the day the application was submitted if no fee is payable under Part 13, so that the applicant is notified about correct lodgement date and process. This is applicable for modification DAs only.

totalFeesPaid
number

This is to track the total fees paid by the applicant. Mandatory only if fee was paid (isFeesPaid is true).

councilReferenceNumber
required
string <= 20 characters

This is to track the internal DA ID generated on the council's IT system.

acceptDate
string <date>

This is to track the date the application was accepted and lodged in the council system. Mandatory if DA has been accepted and lodged. It should be in yyyy-mm-dd format.

returnDate
string <date>

This is to track the application returned date to the applicant. Mandatory if lodgementOutcome is 'Application was returned'.

returnReason
string

This is to track the reason the council returned the application. Mandatory if lodgementOutcome is 'Application was returned'

Array of objects (DownloadableDocument)
updatedByEmail
required
string <= 250 characters

User must be registered in the planning portal.

Responses

Request samples

Content type
application/json
{
  • "lodgementOutcome": "Refer to description for values.",
  • "isFeesPaid": true,
  • "isFeePayableunderPart13": true,
  • "totalFeesPaid": 1250.9,
  • "councilReferenceNumber": "DA201900049",
  • "acceptDate": "2019-08-24",
  • "returnDate": "2019-08-24",
  • "returnReason": "string",
  • "Documents": [
    ],
  • "updatedByEmail": "john.smith@gmail.com"
}
Next to PreliminaryAssessment